3 * Convert from the old links schema (string->ID) to the new schema (ID->ID).
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup Maintenance
24 use MediaWiki\MediaWikiServices
;
26 require_once __DIR__
. '/Maintenance.php';
29 * Maintenance script to convert from the old links schema (string->ID)
30 * to the new schema (ID->ID).
32 * The wiki should be put into read-only mode while this script executes.
34 * @ingroup Maintenance
36 class ConvertLinks
extends Maintenance
{
37 private $logPerformance;
39 public function __construct() {
40 parent
::__construct();
41 $this->addDescription(
42 'Convert from the old links schema (string->ID) to the new schema (ID->ID). '
43 . 'The wiki should be put into read-only mode while this script executes' );
45 $this->addArg( 'logperformance', "Log performance to perfLogFilename.", false );
48 "Filename where performance is logged if --logperformance was set "
49 . "(defaults to 'convLinksPerf.txt').",
54 "Don't overwrite the old links table with the new one, leave the new table at links_temp.",
59 /* (What about InnoDB?) */
60 "Don't create keys, and so allow duplicates in the new links table.\n"
61 . "This gives a huge speed improvement for very large links tables which are MyISAM.",
66 public function getDbType() {
67 return Maintenance
::DB_ADMIN
;
70 public function execute() {
71 $dbw = $this->getDB( DB_MASTER
);
73 $type = $dbw->getType();
74 if ( $type != 'mysql' ) {
75 $this->output( "Link table conversion not necessary for $type\n" );
81 $numBadLinks = $curRowsRead = 0;
83 # total tuples INSERTed into links_temp
84 $totalTuplesInserted = 0;
86 # whether or not to give progress reports while reading IDs from cur table
87 $reportCurReadProgress = true;
89 # number of rows between progress reports
90 $curReadReportInterval = 1000;
92 # whether or not to give progress reports during conversion
93 $reportLinksConvProgress = true;
95 # number of rows per INSERT
96 $linksConvInsertInterval = 1000;
98 $initialRowOffset = 0;
100 # not used yet; highest row number from links table to process
101 # $finalRowOffset = 0;
103 $overwriteLinksTable = !$this->hasOption( 'keep-links-table' );
104 $noKeys = $this->hasOption( 'noKeys' );
105 $this->logPerformance
= $this->hasOption( 'logperformance' );
106 $perfLogFilename = $this->getArg( 'perfLogFilename', "convLinksPerf.txt" );
108 # --------------------------------------------------------------------
110 list( $cur, $links, $links_temp, $links_backup ) =
111 $dbw->tableNamesN( 'cur', 'links', 'links_temp', 'links_backup' );
113 if ( $dbw->tableExists( 'pagelinks' ) ) {
114 $this->output( "...have pagelinks; skipping old links table updates\n" );
119 $res = $dbw->query( "SELECT l_from FROM $links LIMIT 1" );
120 if ( $dbw->fieldType( $res, 0 ) == "int" ) {
121 $this->output( "Schema already converted\n" );
126 $res = $dbw->query( "SELECT COUNT(*) AS count FROM $links" );
127 $row = $dbw->fetchObject( $res );
128 $numRows = $row->count
;
129 $dbw->freeResult( $res );
131 if ( $numRows == 0 ) {
132 $this->output( "Updating schema (no rows to convert)...\n" );
133 $this->createTempTable();
136 if ( $this->logPerformance
) {
137 $fh = fopen( $perfLogFilename, "w" );
139 $this->error( "Couldn't open $perfLogFilename" );
140 $this->logPerformance
= false;
143 $baseTime = $startTime = microtime( true );
144 # Create a title -> cur_id map
145 $this->output( "Loading IDs from $cur table...\n" );
146 $this->performanceLog( $fh, "Reading $numRows rows from cur table...\n" );
147 $this->performanceLog( $fh, "rows read vs seconds elapsed:\n" );
149 $dbw->bufferResults( false );
150 $res = $dbw->query( "SELECT cur_namespace,cur_title,cur_id FROM $cur" );
153 foreach ( $res as $row ) {
154 $title = $row->cur_title
;
155 if ( $row->cur_namespace
) {
156 $title = MediaWikiServices
::getInstance()->getContentLanguage()->
157 getNsText( $row->cur_namespace
) . ":$title";
159 $ids[$title] = $row->cur_id
;
161 if ( $reportCurReadProgress ) {
162 if ( ( $curRowsRead %
$curReadReportInterval ) == 0 ) {
163 $this->performanceLog(
165 $curRowsRead . " " . ( microtime( true ) - $baseTime ) . "\n"
167 $this->output( "\t$curRowsRead rows of $cur table read.\n" );
171 $dbw->freeResult( $res );
172 $dbw->bufferResults( true );
173 $this->output( "Finished loading IDs.\n\n" );
174 $this->performanceLog(
176 "Took " . ( microtime( true ) - $baseTime ) . " seconds to load IDs.\n\n"
179 # --------------------------------------------------------------------
181 # Now, step through the links table (in chunks of $linksConvInsertInterval rows),
182 # convert, and write to the new table.
183 $this->createTempTable();
184 $this->performanceLog( $fh, "Resetting timer.\n\n" );
185 $baseTime = microtime( true );
186 $this->output( "Processing $numRows rows from $links table...\n" );
187 $this->performanceLog( $fh, "Processing $numRows rows from $links table...\n" );
188 $this->performanceLog( $fh, "rows inserted vs seconds elapsed:\n" );
190 for ( $rowOffset = $initialRowOffset; $rowOffset < $numRows;
191 $rowOffset +
= $linksConvInsertInterval
193 $sqlRead = "SELECT * FROM $links ";
194 $sqlRead = $dbw->limitResult( $sqlRead, $linksConvInsertInterval, $rowOffset );
195 $res = $dbw->query( $sqlRead );
197 $sqlWrite = [ "INSERT INTO $links_temp (l_from,l_to) VALUES " ];
199 $sqlWrite = [ "INSERT IGNORE INTO $links_temp (l_from,l_to) VALUES " ];
202 $tuplesAdded = 0; # no tuples added to INSERT yet
203 foreach ( $res as $row ) {
204 $fromTitle = $row->l_from
;
205 if ( array_key_exists( $fromTitle, $ids ) ) { # valid title
206 $from = $ids[$fromTitle];
208 if ( $tuplesAdded != 0 ) {
211 $sqlWrite[] = "($from,$to)";
213 } else { # invalid title
217 $dbw->freeResult( $res );
218 # $this->output( "rowOffset: $rowOffset\ttuplesAdded: "
219 # . "$tuplesAdded\tnumBadLinks: $numBadLinks\n" );
220 if ( $tuplesAdded != 0 ) {
221 if ( $reportLinksConvProgress ) {
222 $this->output( "Inserting $tuplesAdded tuples into $links_temp..." );
224 $dbw->query( implode( "", $sqlWrite ) );
225 $totalTuplesInserted +
= $tuplesAdded;
226 if ( $reportLinksConvProgress ) {
227 $this->output( " done. Total $totalTuplesInserted tuples inserted.\n" );
228 $this->performanceLog(
230 $totalTuplesInserted . " " . ( microtime( true ) - $baseTime ) . "\n"
235 $this->output( "$totalTuplesInserted valid titles and "
236 . "$numBadLinks invalid titles were processed.\n\n" );
237 $this->performanceLog(
239 "$totalTuplesInserted valid titles and $numBadLinks invalid titles were processed.\n"
241 $this->performanceLog(
243 "Total execution time: " . ( microtime( true ) - $startTime ) . " seconds.\n"
245 if ( $this->logPerformance
) {
249 # --------------------------------------------------------------------
251 if ( $overwriteLinksTable ) {
252 # Check for existing links_backup, and delete it if it exists.
253 $this->output( "Dropping backup links table if it exists..." );
254 $dbw->query( "DROP TABLE IF EXISTS $links_backup", __METHOD__
);
255 $this->output( " done.\n" );
257 # Swap in the new table, and move old links table to links_backup
258 $this->output( "Swapping tables '$links' to '$links_backup'; '$links_temp' to '$links'..." );
259 $dbw->query( "RENAME TABLE links TO $links_backup, $links_temp TO $links", __METHOD__
);
260 $this->output( " done.\n\n" );
262 $this->output( "Conversion complete. The old table remains at $links_backup;\n" );
263 $this->output( "delete at your leisure.\n" );
265 $this->output( "Conversion complete. The converted table is at $links_temp;\n" );
266 $this->output( "the original links table is unchanged.\n" );
270 private function createTempTable() {
271 $dbConn = $this->getDB( DB_MASTER
);
273 if ( !( $dbConn->isOpen() ) ) {
274 $this->output( "Opening connection to database failed.\n" );
278 $links_temp = $dbConn->tableName( 'links_temp' );
280 $this->output( "Dropping temporary links table if it exists..." );
281 $dbConn->query( "DROP TABLE IF EXISTS $links_temp" );
282 $this->output( " done.\n" );
284 $this->output( "Creating temporary links table..." );
285 if ( $this->hasOption( 'noKeys' ) ) {
286 $dbConn->query( "CREATE TABLE $links_temp ( " .
287 "l_from int(8) unsigned NOT NULL default '0', " .
288 "l_to int(8) unsigned NOT NULL default '0')" );
290 $dbConn->query( "CREATE TABLE $links_temp ( " .
291 "l_from int(8) unsigned NOT NULL default '0', " .
292 "l_to int(8) unsigned NOT NULL default '0', " .
293 "UNIQUE KEY l_from(l_from,l_to), " .
296 $this->output( " done.\n\n" );
299 private function performanceLog( $fh, $text ) {
300 if ( $this->logPerformance
) {
301 fwrite( $fh, $text );
306 $maintClass = ConvertLinks
::class;
307 require_once RUN_MAINTENANCE_IF_MAIN
;